BBS Toolkit

home *** CD-ROM | disk | FTP | other *** search

/ BBS Toolkit / BBS Toolkit.iso / maximus / mxml_161.zip / MAXMAIL.CFG < prev next >

Wrap

Text File | 1991-06-17 | 25KB | 479 lines

; ; MaxMail configuration file ; ; All parameters oriented as single line records, terminated by usual ; carraige return/linefeed. Use standard text editor to modify. Use ; a ';' to turn off line. Maxmaill will ignore anything on line record ; after it encounters a ';'. Notice that each active record begins with ; Keyword. You can move these lines to any position in file, but keyword ; itself can not be changed. Elsewise, MaxMail will ignore rest of line. ; Each token/field in record is seperated by 1 or more blanks/tab. In ; tokens, Upper/Lower case is not significant! ; ; ; SignOutMsg: Text message displayed to user when MaxMail signs out. Use ; underscore '_' to seperate words instead of blanks. Maxmail will ; substitute underscore for 1 blank space. This is parameter ; is optional. ; SignOutMsg Thanks_for_visiting_Maxmail!_C_you_later!!! ; ; ╔══════════════════════════════════════════════════╗ ; ║THESE TOKENS ARE FOR STANDARD TEXT FORMAT SUPPORT:║ ; ╚══════════════════════════════════════════════════╝ ; ; TxtFile: This is filename MaxMail uses as name for capturing message ; records and embeds into archived file. No pathname is used here, ; just standard 12 letter DOS filename. MaxMail will default to ; "Maxmsgs.txt" if no parameter is specified. ; TxtFile Maxmail.txt ; ; MessageHeader: This is an optional text file that is written to the message ; capture file(TxtFile) *BEFORE* any of the messages. It can ; a little ad or whatever you want to annoy the user with. ; It probably should be made very short, if you use it at all! ; MessageHeader Maxmail.hdr ; ; ╔════════════════════════════════════════╗ ; ║THESE TOKENS ARE FOR QWK FORMAT SUPPORT:║ ; ╚════════════════════════════════════════╝ ; ; Notice: If you want to add standard BULLETIN files to QWK packets for ; users, place text files in the Maximus root directory with ; the following names: ; ; BLT-x.1 <- (x = any digit 0-9) Bulletin #1 ; BLT-x.2 <- (x = any digit 0-9) Bulletin #2, etc etc. ; ; Most QWK readers will scan for these files and offer option ; bulletin viewing if user desires. These files may be any size ; and they are copied to the QWK temporary directory for packing. ; ; ; BBSid: This is a short 8 character name of your bbs. It is used in ; QWK packets as the name for REP (reply) files and in the control ; data packet. This is NOT optional!! This signifies names of QWK ; and REP packets to users, so be sure and give a unqiue name here. ; BBSid MyBBS ; ; QWKWelcome: This is an optional signon file that may be included ; with QWK packets if you wish. It can have ansi graphics,text ; of whatever you wish. Most QWK readers will display it when ; starting up this particular QWK packet upon reading. Any ; standard DOS pathname is acceptable here. ; QWKWelcome MaxMail.wlc ; ; ; QWKNews: This is an optional news file that may be included ; with QWK packets if you wish. It can have ansi graphics,text ; of whatever you wish. Most QWK readers can display it when ; user selects news option. Any standard DOS pathname is acceptable ; here. ; QWKNews Maxmail.nws ; ; ; QWKBye: This is an optional signoff file that may be included ; with QWK packets if you wish. It can have ansi graphics,text ; of whatever you wish. Most QWK readers will display it when ; finishing up reading of this particular QWK packet. Any standard ; DOS pathname is acceptable here. ; QWKBye MaxMail.bye ; ; ; BBSphone: This is your bbs phone number. It is used in building QWK ; packets. It should not be any longer than 14 characters. There ; are no restrictions on format, it is merely a text string. ; ; BBSphone (206)362-3213 ; ; ; Striptags: Answering NO to this option will leave QWKreader tag lines ; in ECHOMAIL areas alone. This defaults to Yes! Normally, ; MaxMail will convert all psuedo tags "---" to spaces and will ; also strip hi bits at tail of message, UNLESS you set HIBIT ; allowed feature in Areas.ctl file. It does NOT tamper with or ; remove the strings, it just converts the chars to ; harmless spaces so Fidonet backbone people are happy! ; WARNING! WARNING! You should leave this option as Yes or ; disabled! Fidonet Backbone people claim they will start ; refusing to process msgs with Hi-bit ("▓") style chars and ; added taglines... But, MaxMail is not politcal so I leave ; it up to sysop control. ; StripTags Yes ; ; ; RepZip: These are the programs used for unpacking QWK REP packets. ; There are only 3 types currently used. Zip,Lharc and Arc ; formats. Just enter the correct un-arc program for each ; (No pathname, just executable name) and the command line. ; %A token is substitute for archived file. ; RepZip PkUnzip.exe _%a RepLha Lha.exe _x_%a RepArc PkXarc.com _%a ; ; ; RepUpload: This is the upload protocol used for receiving QWK REP packets ; back from user for import. Usually this is the same as the ; Protos format except the "s" is usually "r" for receive instead. ; See directions in PROTOS token for any details on subst tokens. ; RepUpload Zmodem_(Best!) Pcz.exe _%p_%b_f_d_rz_%a RepUpload Ymodem_batch_(Fair) Pcz.exe _%p_%b_f_d_ry_%a RepUpload 1Kxmodem_(Fair) Pcz.exe _%p_%b_f_d_r1_%a RepUpload Xmodem_(Worst) Pcz.exe _%p_%b_f_d_rx_%a ; ; ╔════════════════════════════════════╗ ; ║THESE TOKENS ARE FOR SYSTEM SUPPORT:║ ; ╚════════════════════════════════════╝ ; ; Bulletin: This will display a bulletin file upon signon. The file is ; standard ascii text. MaxMail will only display the file IFF ; the date of the bulletin file is newer than the last logon ; date of the user OR the user is new to MaxMail. It will ; automatically be paged to the screen if there are more than ; 23 lines of text. The filename may have a standard DOS path. ; If no drive/pathname given then file is assumed to be in the ; Maximus root directory. ; Bulletin MaxMail.bul ; ; ; NewFilesList: Include an externally generated files (30 day perhaps) ; list as option for user. User will turn this option on ; or off himself. Specify full pathname here. You can use ; a program such as AvailList or Xlist to create this ; special file, nightly if possible. ; NewFilesList MaxMail.new ; ; ; CfgFile: User Configuration file. This is a special binary record MaxMail ; uses to track user configurations. No pathname is used here. ; MaxMail will create file if not existing. If you wish all users ; to redo their configurations, just delete this file and MaxMail ; will restart everyone as new user. Default name is "MaxMail.usr" ; if no parameter specified. ; CfgFile Maxmail.usr ; ; ; LogFile: Log file to track what user does while inside MaxMail. Totally ; compatable with standard Maximus/Binkley log format. You can ; even specify the standard Maximus log file if wanted. It will ; automatically append to it. Logfile is optional,but reccomended ; Any errors occuring will also be logged. ; LogFile MaxMail.log ; ; ; HelpFile: Text file displayed to user if [H]elp function selected on ; menu. This is just a basic text file, nothing fancy. If the ; does not exist, will be dis-abled and a log entry occurs. ; HelpFile MaxMail.hlp ; ; ; NewHelpFile: Text file displayed to new user at signon. If MaxMail can not ; find user in config file, it will first display this file to ; user, with automatic paging every 23 lines. Do not put any control ; characters in file, but IBM text (8 bit chars) may be used. ; This file is optional, but reccomended to explain to new user ; what MaxMail is all about. Keep file short and to the point. ; NewHelpFile NewUsers.max ; ; ; MaxDailyCalls: Maximum number of times any user pack up messages per 24 ; 24 hours. It ignores this value if user is >= Ast Sysop level ; or calling in local mode. If you set the value to 0, it will not ; check the counter. On my bbs, because I grant the MaxMail time ; back to users, I have found some people are taking advantage of ; it too much, by reloading MaxMail several times and thus hogging ; the bbs for long times! I still want to encourage usage, but not ; abusiveness, so I added this little function to gain more fine ; control. This value is tracked on a user by user basis and is ; ignored if user calls AFTER 24 hours from last call of course. ; Value placed here should be between 0 and 255. Anything above ; 255 is silly and is rounded down anyways. This value is not ; check for other functions in MaxMail such as reply uploads. ; MaxDailyCalls 1 ; ; ; MaximumMessages: Maximum count of messages to pack in 1 session. MaxMail ; will check remaining time for user and not allow larger archived ; file than user can download (current baud rate) during time. It ; is a rough estimate at best though, since we can only guess the ; maximum messages specified here. 400 is a good reasonable number. ; User can always recall MaxMail later for additional messages. ; MaximumMessages 400 ; ; ; SkipAreas: Specifies MaxMail message areas you do NOT want the user to ; pack up for some reason or other. Of course MaxMail will NOT ; allow user to scan any areas he does not have KEYS and PRIV ; access to, so these areas listed here should only be general ; message areas that most or all users have access to, but don't ; want them to be packed up with MaxMail. If you specify multiple ; areas use a comma to seperate as in the example. If the user ; happens to have ASSTSYSOP level priveledge, this will be ignored, ; i.e. the areas will be scanned anyways. The area numbers ; are REFERENCES (i.e. they are actually the index value in ; Area.dat) they are not necessarily the same as area names you ; give. Area #0 is the first area in area.ctl,1 is second, etc. ; ;SkipAreas 2,3 ; ; ForceAreas: Specifies MaxMail message areas you want to FORCE the user ; to pack up for some reason or other. Of course MaxMail will NOT ; allow user to scan any areas he does not have KEYS and PRIV ; access to, so these areas listed here should only be general ; message areas that most or all users have access to, but you ; want them to be always packed up with MaxMail. If you specify ; multiple areas use a comma to seperate as in the example. The ; area numbers given are REFERENCES (i.e. they are actually the ; index value in Area.dat) they are not necessarily the same as ; area names you give. Area #0 is the first area in area.ctl, ; 1 is second, etc. ; ;ForceAreas 1 ; ; ; TempDir: Specify a temporary directory used for building and packing ; up message files. Should have a full drive and pathname in ; it. Adding a trailing "\" is not required. We will check for it ; and add it if necessary. If you specify this it MUST have a ; drive letter as well! Not just a directory! Specifying a ram ; disk here is probably a good idea. ; TempDir t:\ ; ; ; ExtendedBarrier: Tell MaxMail how to handle an extended Barrier ; message area. If token is "Yes" then user will be ; allowed read access. If token is anything else ; any message area with an extended barrier file ; will be locked out from users. Defaults to "Yes" ; ; Notice: A standard OPUS style barricaded area is ; supported as expected, asking user for password before ; first time access. A Maximus extended barricaded file ; is recognized by '!' character as first char in token line. ; ExtendedBarrier Yes ; ; ; UseCommand: If you are having problems shelling the packer, or your packer ; program is actually a batch file, place a "Yes" here which ; will call command.com to shell packer program instead of ; direct execution. ; UseCommand No ; ; ; DownloadHangup: Enable user to hang up after downloading. Answer ; "String" or "DTR", depending on which mode you wish, ; if you want user to have this feature. Put a "NO" here ; to disable it and user won't have the option. If the ; feature is enabled, MaxMail has a deadlock counter and ; after issuing the hang-up command to the modem, it will ; loop for short period of time checking carrier. If for ; some reason the modem does not hangup, MaxMail will still ; exit cleanly, but with an exit code of 5. In "STRING" ; mode, MaxMail uses the standard Hayes "ATH0" command to ; hangup the modem. Useful for *PARTIALLY* compat modems. In ; "DTR" mode, MaxMail will toggle DTR, just like Maximus does. ; This works for most modems but not all. ; DownloadHangup Dtr ; ; ; Colors: Tell MaxMail what colors to use where. Of course these ; colors are ONLY displayed if user has set ANSI or AVATAR ; video modes. Currently there are 7 different types of text ; attributes defined as follows: ; ;Standard Text,Hilite Text,Menu Items,Time Left,Prompt,Attention Text,View Text ; ; A standard set is included as follows. You should have all ; 6 values filled in, else it will just repeat last value ; until six items are in the color set. You will just have ; to play with these values to see which ones are applied ; to what text. I have tried to use labels that make sense ; at least to me! The local screen will always display the ; what user is seeing. Even if user is in Avatar mode, the ; local screen will display the ANSI version of the colors, ; which is the same of course but not Avatar codes. ; ; Though these tokens are in DECIMAL value, attributes ; are the standard 8 bit IBM char attributes. Upper 4 bits ; are the background (high bit is blink) and lower 3 bits are ; the foreground (I always set the intensity bit). Here are ; the standard IBM color codes: ; ; 0 Black 4 Blue ; 1 Red 5 Magenta ; 2 Green 6 Cyan ; 3 Yellow 7 White ; ; If you decide to use any background color other than black, you ; might get some messy results. Feel free to experiment. The local ; mode will look the same as the remote user sees it. Remember the ; values are in DECIMAL not HEX. ; colors 06,03,02,87,07,01,71 ; ; ; ReDirectPacker: If you wish to redirect the console output while the ; the packer program is being shelled, answer "Yes" here. It ; will only work if the current COM port being used is a valid ; DOS device. MaxMail will look for devices GATE1,GATE2, etc. ; (Gateway device driver) first and use that if possible. Also ; some packer programs do NOT use STDOUT so they may not work ; with this. We also redirect STDERR so that may help. Dos will ; always use the standard fossil calls during the re-direction. ; ReDirectPacker YES ; ; ; Packer: Here is where you specify the packer programs user is allowed. ; You can specify as many packers as you want. Menu will display ; them in order appearing here. So if you change packers or the ; order of them, you probably want to force users to re-do their ; configuration (delete User Config file), or use Utility mode. ; There are 4 tokens (seperated by tab/blank) required. Any lines ; with less than 4 tokens will be ignored. Be sure each token has ; *NO* embedded spaces/tabs, else it will be considered another ; token! Use an underscore "_" in place of blank space. See the ; examples here if confused. Tokens are: ; ; Description Filename PackedFilename CommandLine ; --------------------------------------------------- ; Description: Simple short description of packer type. ; Obviously you should use something meaningful, ; as this text will be shown to user in menu ; selection for packer type. ; ; Filename: 12 letter filename (no paths!) of packer ; program. Be sure it's on your DOS path somewhere ; and MaxMail will find it. Just name and ; extension. ; ; PackedFilename: 12 letter filename (no paths!) which will ; be packed filename. Actually MaxMail will only ; use first 6 characters of filename and add a ; numeric series (00,01,02,etc) to pad onto name. ; Extension will be whatever you specify though, ; but it should be default one that packer program ; expects. Prob you should use name of your bbs ; (1st 6 chars or whatever) to indicate to user ; where file came from. ; ; CommandLine: Command line to pass to packer. Again, make sure ; there are no embedded spaces! Use an underscore. ; You have a substitute token you will have to ; embed here. It begins with '%' character: ; ; %a: Subtitutes PackedFilename. ; ; This token can be located anywhere in the ; command line string of course. See examples ; below for clarity. We use standard packers ; here but you can always add any exotic ; new packer you wish! Very flexible huh? In ; building the arc packet the file to be added ; will be appended to this string, so it assumed ; that the input filename MUST be the last token ; on the packer's command line. ; ; ViewLine: This is an optional field. It is the command ; line for viewing the archived packfile. MaxMail ; ,if it sees this field, will call up the packer ; program again, executing this command line. It ; is expected this is the command to display the ; archived file, using standard DOS output. MaxMail ; will re-route that output to a text file, then ; display the file to the user. Thus the user can ; confirm what the packed file looks like. Just ; a nice additional feature. It uses the same ; substitute token as the previous field. If ; you don't want to bother with this, just put a ; semicolon in front of this, or remove the ; string. ; ; Packer LHa_(Tightest) Lha.exe Crnstn.lzh _a_%a _l_%a Packer PKzip_(Popular) Zip.exe Crnstn.zip _-a_%a _-vb_%a Packer Arc_(Universal) Arca.com Crnstn.arc _%a Packer Zoo_(unix_compat) Zoo.exe Crnstn.zoo _-add_%a _-list_%a Packer Pak_(flexible) Pak.exe Crnstn.pak _A_%a _L_%a Packer Arj_(New) Arj.exe Crnstm.arj _a_%a _v_%a ; ; ; Protos: Here is where you specify the xfer protocols user is allowed. ; You can specify as many protocols as you want. Menu will display ; them in order appearing here. So if you change them or the order ; of them, you probably want to force users to re-do their ; configuration (delete User Config file), or use Utility mode. ; There are 3 tokens (seperated by tab/blank) required. Any lines ; with less than 3 tokens will be ignored. Be sure each token has ; *NO* embedded spaces/tabs, else it will be considered another ; token! Use an underscore "_" in place of blank space. See the ; examples here if confused. Tokens are: ; ; Description Filename PackedFilename CommandLine ; --------------------------------------------------- ; Description: Simple short description of protocol type. ; Obviously you should use something meaningful, ; as this text will be shown to user in menu ; selection for protocol. ; ; Filename: 12 letter filename (no paths!) of protocol ; program. Be sure it's on your DOS path somewhere ; and MaxMail will find it. Just name and ; extension. Currently we have used PCZ.exe here ; You can try out any others you wish, but be ; and test them first. ; ; CommandLine: Command line to pass to protocol program. Again, ; make sure there are no embedded spaces! Use an ; underscore. You have 3 substitute tokens you can ; embed here. They begin with '%' character: ; ; %a: Subtitutes PackedFilename. ; %p: Subtitutes current com port. 1 based, ; I.E. 1 = com1,2=com2,etc. ; %b: Current baud rate. ; ; These tokens can be located anywhere in the ; command line string of course. See examples ; below for clarity. We use standard protocols ; here but you can always add any exotic ; new protocols you wish! Very flexible huh? ; Protos Zmodem_(Best!) Pcz.exe _%p_%b_f_d_sz_%a Protos Ymodem_batch_(Fair) Pcz.exe _%p_%b_f_d_sy_%a Protos 1Kxmodem_(Fair) Pcz.exe _%p_%b_f_d_s1_%a Protos Xmodem_(Worst) Pcz.exe _%p_%b_f_d_sx_%a ; ; ; ; If you are using DSZ instead of PCZ, these settings are reccomended by ; other sysops who have used this for the protocol selections. ; ;Protos Zmodem_(Best!) dsz.com _ha_slow_sz_-m_%a ;Protos Ymodem_batch_(Fair) dsz.com _ha_slow_sb_-k_%a ;Protos 1Kxmodem_(Fair) dsz.com _ha_slow_sx_-k_%a ;Protos Xmodem_(Worst) dsz.com _ha_slow_sx_%a ;